VLOOMシステム外部公開API
VLOOMシステムでは3つのAPIを公開しています。
① ClickToCallリクエスト
② 通話履歴リクエスト
③ 録音データリクエスト
リクエストが正常に処理された場合、レスポンスに含まれるResultCodeは”0000″で返却されます。
使用するための事前確認
APIをリクエストする際に必要となるAPIキーを確認します。
①サイドメニューから［管理］を選択し、上部タブにて［全体設定］を選択してください。
②末尾まで移動し、APIの設定欄に存在するAPIキーを確認してください。
新たにAPIキーを発行する場合は、「追加」ボタンから発行が可能です。
ClickToCallリクエスト
概要
APIリクエストを受け取ることで、VLOOMから発信を行います。
発信元のユーザーはステータスが「受付可、後処理、離席」（発信できる状態）である必要があります。
このAPIを利用することで、外部システム上でのクリック発信等が可能です。
※発信者通知番号を指定する場合は、CallerNotificationNumに業務設定で登録している発信者通知番号を設定してください。
※発信者通知番号を指定しない場合は、電話機（ソフトフォン、ブラウザフォン）で選択されている発信者通知番号が使用されます。ハードフォンの場合はデフォルト発信者通知番号が使用されます。
リクエスト
Method
POST
URL
/api/v1/ex/makecall
リクエストパラメーター
リクエストサンプル
|
{
“TenantId”: “123”,
“ApiKey”: “00000000-0000-0000-0000-000000000000”,
“CallerNum”: “6001”,
“TelNum”: “0300000000”,
“CallerNotificationNum”:”0300000000″
}
|
レスポンス
レスポンスパラメーター
レスポンスには処理結果が設定されます。
| パラメーター名 | データ型 | 内容 |
| ResultCode | String | 結果コード |
| Message | String | メッセージ |
レスポンスサンプル
| { “ResultCode”: “0000”, “Message”: “success” } |
通話履歴リクエスト
概要
API対応履歴（管理画面）に登録されている通話履歴データを取得することができます。
このAPIを利用することで、通話に関する情報を外部システムへ連携し、活用することが可能です。
※リクエスト時にUniqueIDもしくはCallIDを要する為、トリガー／アクション機能等で事前にIDを外部システムへ連携する必要があります。
リクエスト
Method
POST
URL
/api/v1/ex/callhistory
リクエストパラメーター
| パラメーター名 | データ型 | 内容 |
|---|---|---|
| TenantId | Integer | 契約会社IDに紐づくテナントID |
| APIKey | String | 事前に確認したAPIキー |
| UniqueId | String | 対応履歴（管理画面）に登録されている通話履歴のユニークID |
| CallId | String | 対応履歴（管理画面）に登録されている通話履歴のコールID |
※UniqueId、CallIdはいずれかの指定が必須
リクエスト例
|
{
“TenantId”: 123,
“ApiKey”: “00000000-0000-0000-0000-000000000000”,
“CallId”: “ip-10-5-1-85-1686877912.98”
}
|
レスポンス
レスポンスパラメーター
レスポンスには以下の情報が含まれます。
①通話情報（通話開始日時、通話終了日時、通話内での保留時間と保留回数、応対したユーザー（内線番号含む）、登録した対応メモ、通話に紐づく業務情報）
②音声認識結果（音声認識がありの状態で実施した場合のみ、通話の音声を文字とし取得）
③コメントリスト（対応履歴（管理画面）よりユニークIDまたは コールIDに紐づく形で登録されたコメント）
| パラメーター名 | データ型 | 内容 |
| ResultCode | String | 結果コード |
| UniqueId | String | ユニークID |
| CallHistories | List | 通話履歴リスト |
| [CallHistories] CallId | String | コールID |
| [CallHistories] StartDate | datetime | 通話開始日時 |
| [CallHistories] EndDate | datetime | 通話終了日時 |
| [CallHistories] Extension | String | 内線番号 |
| [CallHistories] UserId | String | 応対ユーザー |
| [CallHistories] CustomerTelnum | String | 顧客電話番号 |
| [CallHistories] Direction | int | 通話方向 |
| [CallHistories] MemoId | bigint | 対応メモID |
| [CallHistories] MemoName | String | 対応メモ名称 |
| [CallHistories] MemoFree | String | 対応メモその他 |
| [CallHistories] HoldCnt | int | 保留回数 |
| [CallHistories] HoldTime | time | 保留時間 |
| [CallHistories] ProjectId | bigint | 業務ID |
| [CallHistories] ProjectName | String | 業務名 |
| [CallHistories] DialIn | String | ダイヤルイン番号 |
| [CallHistories] InRouteNum | String | 着信経路番号 |
| [CallHistories] SpeechRecognition | List | 音声認識結果リスト |
| [SpeechRecognition] CallId | String | コールID |
| [SpeechRecognition] RecognitionResult | List | 音声認識結果 |
| [RecognitionResult] RecognitionResultId | bigint | 音声認識結果ID |
| [RecognitionResult] ChannelType | enum | 発声者区分（0: カスタマー, 1: OP） |
| [RecognitionResult] StartTime | float | 発声時間（秒） |
| [RecognitionResult] SpeechTime | float | 発話時間（秒） |
| [RecognitionResult] TelNum | String | 電話番号 |
| [RecognitionResult] UserName | String | ユーザー名 |
| [RecognitionResult] ResultText | Text | 音声認識結果テキスト |
| [RecognitionResult] NgWordList | json | NGワード一覧 |
| [RecognitionResult] FaqWordList | json | FAQワード一覧 |
| [CallHistories] CommentList | List | コメントリスト |
| [CommentList] Id | bigint | コメント通番ID |
| [CommentList] UserId | String | ユーザーID |
| [CommentList] UserName | String | ユーザー名 |
| [CommentList] Comment | Text | コメント内容 |
| [CommentList] UpdateDate | datetime | 最終更新日時 |
レスポンス例
| { “ResultCode”: “0000”, “UniqueId”: null, “CallHistories”: [ { “CallId”: “ip-10-5-1-85-1686877912.98”, “StartDate”: “2023-06-16T01:11:48.440000+00:00”, “EndDate”: “2023-06-16T01:16:04.543000+00:00”, “UserId”: 19531, “Direction”: 1, “MemoId”: null, “MemoFree”: “音声認識を使用するための設定についてお問い合わせ。”, “HoldCnt”: null, “HoldTime”: “00:00:00+00:00”, “ProjectId”: 417, “MemoName”: “”, “Extension”: “221”, “CustomerTelnum”: “07000000000”, “ProjectName”: “Brastel7781”, “DialIn”: “0300000000”, “InRouteNum”: “7781”, “SpeechRecognition”: [ { “CallId”: “ip-10-5-1-85-1686877912.98”, “RecognitionResult”: [ { “RecognitionResultId”: 1381, “ChannelType”: “op”, “StartTime”: 4.501, “SpeechTime”: 1.905, “TelNum”: “07000000000”, “UserName”: “fuji1”, “ResultText”: “お電話ありがとうございます。”, “NgWordList”: { “209”: “ありがとう” }, “FaqWordList”: { } }, { “RecognitionResultId”: 1382, : } ] }, { “CallId”: “ip-10-5-1-85-1686877908.97”, “RecognitionResult”: [ { “RecognitionResultId”: 1386, “ChannelType”: “customer”, “StartTime”: 58.404, “SpeechTime”: 1.719, “TelNum”: “07000000000”, “UserName”: “fuji1”, “ResultText”: “お世話になっております。”, “NgWordList”: { }, “FaqWordList”: { } }, { “RecognitionResultId”: 1387, : } ] } ], “CommentList”: [ ] } ] } |
録音データリクエスト
概要
対応履歴（管理画面）に登録されている通話データの中から録音データを取得することができます。
このAPIを利用することで、外部システムへ録音データを連携することが可能となります。
※リクエスト時にUniqueIDもしくはCallIDを要する為、トリガー／アクション機能等で事前にIDを外部システムへ連携する必要があります。
※録音データの格納先パス情報がレスポンス情報となるので、該当のパスへアクセスしてデータを取得してください。
リクエスト
Method
POST
URL
/api/v1/ex/recordingdata
リクエストパラメーター
| パラメーター名 | データ型 | 内容 |
|---|---|---|
| TenantId | Integer | 契約会社IDに紐づくテナントID |
| APIKey | String | 事前確認で確認したAPIキー |
| UniqueId | String | 対応履歴（管理画面）に登録されている通話履歴のユニークID |
| CallId | String | 対応履歴（管理画面）に登録されている通話履歴のコールID |
レスポンス
レスポンスパラメーター
レスポンスには録音データのパス情報が設定されます。
| パラメーター名 | データ型 | 内容 |
| ResultCode | String | 結果コード |
| Location | String | 録音データのパス情報 |
レスポンス例
| { ”ResultCode”: “0000”, ”headers”: [ { ”Location”:”https://prd-001-s3.s3.amazonaws.com/recordingfile/20230211/02/1676082131.17_1676082132.19.wav?AWSAccessKeyId=XXXXXXXXXX” } ] } |